All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.std.anim.Sprite

java.lang.Object
   |
   +----quicktime.QTObject
           |
           +----quicktime.std.anim.Sprite

public final class Sprite

extends QTObject

implements QuickTimeLib, PrimitivesLib

Sprite(SpriteWorld, ImageDescription, EncodedImage, Matrix, boolean, int)

This constructor creates a new Sprite object for a specified sprite world.

getGraphicsMode()

This method gets the graphics mode property of this sprite.

getImageData()

This method gets the image data property of this sprite.

getImageDataSize()

This method gets the size of the image data that a sprite is currently displaying.

getImageDescription()

This method gets the image description property of this sprite.

getInitialSize()

This method returns the original width and height of the image currently being presented by the sprite.

getLayer()

This method gets the layer property of this sprite.

getMatrix()

This method gets the matrix property of this sprite.

getSpriteWorld()

Return the sprite world that this sprite belongs too

getVisible()

This method gets the visibility property of this sprite.

hitTest(int, QDPoint)

This method tests if a point is inside a sprite.

invalidate()

This method invalidates the portion of the sprite's sprite world which is occupied by the sprite.

remove()

This will remove the sprite from the SpriteWorld it is contained in and destroy its internal structures.

setGraphicsMode(GraphicsMode)

This method sets the graphics mode property of this sprite.

setImageData(EncodedImage)

This method sets the image data property of this sprite.

setImageDataIfDifferent(EncodedImage)

This method sets the image data property of this sprite.

setImageDataSize(int)

This method sets the size of the image data that the sprite is currently displaying.

setImageDescription(ImageDescription)

This method sets the image description property of this sprite.

setLayer(int)

This method sets the layer property of this sprite.

setMatrix(Matrix)

This method sets the matrix property of this sprite.

setVisible(boolean)

This method sets the visibility property of this sprite.

 public Sprite(SpriteWorld itsSpriteWorld,
               ImageDescription idh,
               EncodedImage imageData,
               Matrix matrix,
               boolean visible,
               int layer) throws QTException

This constructor creates a new Sprite object for a specified sprite world.

QuickTime::NewSprite()

Parameters:

itsSpriteWorld - Specifies the sprite world.

idh - an ImageDescription object that describes the image.

imageData - Contains the sprite's image data.

matrix - A Matrix object describing the sprite's matrix.

visible - True if the sprite is visible.

layer - The sprite's layer.

 public SpriteWorld getSpriteWorld()

Return the sprite world that this sprite belongs too

 public void invalidate()

This method invalidates the portion of the sprite's sprite world which is occupied by the sprite.

QuickTime::InvalidateSprite ()

 public boolean hitTest(int flags,
                        QDPoint loc) throws StdQTException

This method tests if a point is inside a sprite.

QuickTime::SpriteHitTest ()

Parameters:

flags - Specifies the control flags.

loc - Specifies the test point.

Returns:

true if the point is inside the sprite, false if not.

 public Matrix getMatrix() throws StdQTException

This method gets the matrix property of this sprite.

QuickTime::GetSpriteProperty ()

Returns:

the matrix.

 public void setMatrix(Matrix matrix) throws StdQTException

This method sets the matrix property of this sprite.

QuickTime::SetSpriteProperty ()

Parameters:

matrix - Specifies the matrix.

 public ImageDescription getImageDescription() throws StdQTException

This method gets the image description property of this sprite.

QuickTime::GetSpriteProperty ()

Returns:

the image description.

 public Dimension getInitialSize() throws StdQTException

This method returns the original width and height of the image currently being presented by the sprite.

QuickTime::GetSpriteProperty ()

Returns:

a Dimension

 public void setImageDescription(ImageDescription idh) throws StdQTException

This method sets the image description property of this sprite.

QuickTime::SetSpriteProperty ()

Parameters:

idh - Specifies the image description.

 public RawEncodedImage getImageData() throws StdQTException

This method gets the image data property of this sprite.

QuickTime::GetSpriteProperty ()

Returns:

the image data.

 public void setImageData(EncodedImage data) throws StdQTException

This method sets the image data property of this sprite. It will also set the size of the image data to the size of the pointer. If the actual size of the image data is smaller than the handle you should set the imageDataSize after this call to the desired size.

QuickTime::SetSpriteProperty ()

Parameters:

data - Specifies the image data.

 public boolean setImageDataIfDifferent(EncodedImage data) throws StdQTException

This method sets the image data property of this sprite. It will also set the size of the image data to the size of the pointer. If the actual size of the image data is smaller than the handle you should set the imageDataSize after this call to the desired size.

This method can be useful to use if the SpriteWorld the Sprite is a member of should be redrawn after changing the image data of a Sprite.

QuickTime::SetSpriteProperty ()

Parameters:

data - Specifies the image data.

Returns:

a boolean which indicates if the incoming image data is different (true) than the previous data the sprite was presented.

 public boolean getVisible() throws StdQTException

This method gets the visibility property of this sprite.

QuickTime::GetSpriteProperty ()

Returns:

the visibility.

 public void setVisible(boolean visible) throws StdQTException

This method sets the visibility property of this sprite.

QuickTime::SetSpriteProperty ()

Parameters:

visible - Specifies the visibility.

 public int getLayer() throws StdQTException

This method gets the layer property of this sprite.

QuickTime::GetSpriteProperty ()

Returns:

the layer.

 public void setLayer(int layer) throws StdQTException

This method sets the layer property of this sprite.

QuickTime::SetSpriteProperty ()

Parameters:

layer - Specifies the layer.

 public GraphicsMode getGraphicsMode() throws StdQTException

This method gets the graphics mode property of this sprite.

QuickTime::GetSpriteProperty ()

Returns:

the graphics mode.

 public void setGraphicsMode(GraphicsMode gMode) throws StdQTException

This method sets the graphics mode property of this sprite.

QuickTime::SetSpriteProperty ()

Parameters:

gMode - Specifies the graphics mode.

 public int getImageDataSize() throws StdQTException

This method gets the size of the image data that a sprite is currently displaying.

QuickTime::GetSpriteProperty ()

Returns:

the size of the image data

 public void setImageDataSize(int size) throws StdQTException

This method sets the size of the image data that the sprite is currently displaying. If you know the size of the image data it is recommended that you set this.

QuickTime::SetSpriteProperty ()

Parameters:

size - the size of the image data

 public void remove()

This will remove the sprite from the SpriteWorld it is contained in and destroy its internal structures. The Sprite is not usuable after this call. If you have any other java objects that refer to this sprite, they will also be unusable - so use this call with care.

QuickTime::DisposeSprite ()

All Packages  Class Hierarchy  This Package  Previous  Next  Index